IMotion.JogAxis method

Commands a never-ending controlled motion at a specified velocity. Unlike MoveAxisVelocity, JogAxis doesn't have BufferMode. It keeps moving until the jog input is reset.

Namespace: IntervalZero.KINGSTAR.Base.Api

Assembly: IntervalZero.KINGSTAR.Base.Api (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

C#VB

KsCommandStatus JogAxis(
       int Index,
       double Velocity,
       double Acceleration,
       double Deceleration,
       double Jerk,
       McDirection Direction
)

Function JogAxis(
       Index As Integer,
       Velocity As Double,
       Acceleration As Double,
       Deceleration As Double,
       Jerk As Double,
       Direction As McDirection
) As KsCommandStatus

Parameters

Index [in]

Type: int

The index of an axis. Indexes are zero based. Aliases affect this parameter.

Velocity [in]

Type: double

A value of the specified velocity. [unit/second]

Acceleration [in]

Type: double

A value of the acceleration. The unit is determined by McProfileType. (increasing energy of the motor) [unit/second²] or [second]

Deceleration [in]

Type: double

A value of the deceleration. The unit is determined by McProfileType. (decreasing energy of the motor) [unit/second²] or [second]

Jerk [in]

Type: double

A value of the jerk. The unit is determined by McProfileType. [unit/second³] or [second]

Direction [in]

Type: McDirection

The direction of a jog move. It can be mcPositiveDirection or mcNegativeDirection.

Return value

Type: KsCommandStatus

Returns the KsCommandStatus class.

Remarks

Because JogAxis keeps controlling the axis, it triggers an error if a limit is reached.

Examples

N/A